Skip to content

Fix deployment help links and coverage gaps#232

Merged
stiwicourage merged 3 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles
May 24, 2026
Merged

Fix deployment help links and coverage gaps#232
stiwicourage merged 3 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles

Conversation

@stiwicourage

Copy link
Copy Markdown
Owner

Summary

  • Normalizes staged docs/NovaModuleTools/en-US/*.md RELATED LINKS sections to the official PlatyPS shape by using bulleted Markdown links instead of GitHub blob URLs or bare/backticked command names.
  • Adds a focused guardrail test so future help updates keep using valid related-link syntax and do not drift back to GitHub/blob links.
  • Updates the PlatyPS help instruction and its scaffold mirror so the rule is explicit for future repository and scaffolded help work.

Affected area

  • nova CLI or command routing
  • Public PowerShell cmdlet behavior
  • Scaffolding or project.json handling
  • Build, test, analyzer, coverage, or CI helper flow
  • Package, raw upload, or package metadata workflow
  • Publish, release, or GitHub Actions automation
  • Self-update or notification preference behavior
  • Contributor documentation (README.md, CONTRIBUTING.md, repository workflow docs)
  • End-user docs (docs/*.html)
  • Command help (docs/NovaModuleTools/en-US/*.md)
  • src/resources/example/
  • Dependency or manifest changes (project.json, workflow dependencies, release tooling)
  • Security-sensitive change
  • Documentation-only change
  • Agentic Copilot Workflow + scaffold mirror + scaffold-sync guardrail test.
  • Other

Review guidance

  • Start with the staged help files under docs/NovaModuleTools/en-US/ and confirm the RELATED LINKS sections now use relative Markdown links such as ./Invoke-NovaBuild.md.
  • Then review tests/CommandHelpRelatedLinks.Tests.ps1 and .github/instructions/platyps-help.instructions.md together; they define and enforce the new authoring rule.
  • Also note the synced scaffold mirror at src/resources/agentic-copilot/.github/instructions/platyps-help.instructions.md.
  • Trade-off: the staged change standardizes authoring and preserves internal .md link URIs in exported MAML, but it does not broaden the scope into website-doc or release-pipeline changes.

Validation

  • Invoke-NovaBuild
  • Test-NovaBuild
  • ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
  • ./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1
  • Targeted Nova workflow validated (% nova build, % nova test, % nova merge, % nova deploy, % nova publish, % nova release, % nova update, % nova notification, or % nova init as relevant)
  • Docs/example only; executable validation not needed

Validation notes:

Invoke-NovaBuild
Import-Module ./dist/NovaModuleTools/NovaModuleTools.psd1 -Force
Test-MarkdownCommandHelp -Path ./docs/NovaModuleTools/en-US/*.md -DetailView
pwsh -NoLogo -NoProfile -File ./run.ps1

Observed results:
- Test-MarkdownCommandHelp passed for the command-help set
- exported dist/NovaModuleTools/en-US/NovaModuleTools-Help.xml preserves internal related-link URIs such as ./Invoke-NovaBuild.md
- run.ps1 passed, which covered ScriptAnalyzer plus Test-NovaBuild
- staged change does not alter main/develop publish semantics; it is safe for the current 3.0.2-preview prerelease line

Documentation and release follow-up

  • README.md reviewed and updated if contributor workflow, architecture, CI, release, or automation changed
  • CONTRIBUTING.md reviewed and updated if contribution expectations or review guidance changed
  • CHANGELOG.md reviewed and updated if the change matters to users, maintainers, or contributors
  • RELEASE_NOTE.md reviewed and updated if the change affects public cmdlet usage, CLI usage, configuration semantics, or migration expectations
  • docs/NovaModuleTools/en-US/ help updated if a public command or CLI behavior changed
  • docs/*.html updated if end-user workflows or examples changed
  • src/resources/example/ reviewed and updated if the real-world project layout, package model, or upload workflow changed
  • No documentation, changelog, release-note, or example updates were needed

Maintainability, compatibility, and risk

  • Code Health / maintainability impact considered
  • No breaking change
  • Breaking change
  • Security-sensitive change
  • CI, workflow, or release-pipeline impact
  • Dependency-review impact

Risk, rollout, or rollback notes:

Preview/prerelease impact:
- the current project version is 3.0.2-preview, so this staged change will ship on the prerelease line first if merged to develop
- behavior is documentation/help-only plus one guardrail test; no prerelease-specific publish/version logic changed

Compatibility:
- low risk
- public command behavior is unchanged
- the main user-visible effect is better related-topic navigation in PowerShell help authoring/output

Rollback:
- revert the RELATED LINKS edits in docs/NovaModuleTools/en-US/*.md
- revert tests/CommandHelpRelatedLinks.Tests.ps1
- revert the PlatyPS instruction update and synced scaffold mirror

Important

Do not use a public pull request to disclose a vulnerability before coordinated handling.
Use the private reporting path in SECURITY.md for new security issues.

@github-actions

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Coverage Gates Passed
Overall Coverage: 99.4% (required = 95%)
New & Changed Code Coverage: 100% (required = 99%)

Review details by gate
  • Overall Coverage

    • Pass/Fail Reason:
      The overall coverage gate was checked for all code and meets the goal: 99.4% covered >= threshold = 95%
    • Action:
      You have 292 files with a sum of 3280 covered and 19 uncovered lines of code.
  • New & Changed Code Coverage

    • Pass/Fail Reason:
      New or changed code meets coverage goal: 100% covered >= threshold = 99%
    • Action:
      You modified 5 files, and covered 52 added/modified lines of code.

@stiwicourage
stiwicourage merged commit 4a996ef into develop May 24, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant